feat: First tentative for Plugin Mapdl Mechanism python API #3627
Conversation
|
Thanks for opening a Pull Request. If you want to perform a review write a comment saying: @ansys-reviewer-bot review |
|
I will check it out next year. #HappyVacations |
|
Can't wait to discuss about it early next year when I visit you @FredAns 😃 . |
| @@ -2767,6 +2768,26 @@ def xpl(self) -> "ansXpl": | |||
| self._xpl = ansXpl(self) | |||
| return self._xpl | |||
|
|
|||
| @property | |||
| def plugin(self) -> "ansPlugin": | |||
There was a problem hiding this comment.
| def plugin(self) -> "ansPlugin": | |
| def plugin(self) -> ansPlugin: |
| >>> plugin.load('PluginDPF') | ||
| """ | ||
| if self._plugin is None: | ||
| from ansys.mapdl.core.plugin import ansPlugin |
There was a problem hiding this comment.
| from ansys.mapdl.core.plugin import ansPlugin |
It seems to me there is no reason to delay the import. You can delete this line and then apply my previous comment (remove quotes).
Or delete the import at the beginning and leave these lines as it is.
| command = f"*PLUG,LOAD,{plugin_name},{feature}" | ||
| response = self._mapdl.run(command) | ||
| if "error" in response.lower(): | ||
| raise PluginLoadError( |
There was a problem hiding this comment.
You should create this type of exception in ansys.mapdl.core.errors, ideally inheritate from MapdlException or MapdlRuntimeError.
src/ansys/mapdl/core/plugin.py
Outdated
| raise PluginLoadError( | ||
| f"Failed to load plugin '{plugin_name}' with feature '{feature}'." | ||
| ) | ||
| return f"Plugin '{plugin_name}' with feature '{feature}' loaded successfully." |
There was a problem hiding this comment.
Why are you not returned the original MAPDL response response?
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
Codecov ReportAttention: Patch coverage is
❌ Your patch check has failed because the patch coverage (7.14%) is below the target coverage (90.00%). You can increase the patch coverage or adjust the target coverage. Additional details and impacted files@@ Coverage Diff @@
## main #3627 +/- ##
==========================================
- Coverage 88.29% 88.06% -0.23%
==========================================
Files 187 188 +1
Lines 14819 14861 +42
==========================================
+ Hits 13084 13087 +3
- Misses 1735 1774 +39 🚀 New features to boost your workflow:
|
|
I'm having a look at this PR.
|
Description
**There's now a new command in MAPDL, called *PLUG, to allow the loading of external dynamic libraries, to dynamically add custom commands and features in MAPDL ( for the time of the session). There are a few plugins already shipped with MAPDL ( The gRPC server lib and the DPF Plugin) we can load and use this way.
I've copy/paste what was done for the XPL API implementation **
Issue linked
There's a TFS User Story for this action. But not already a Github ID.
Checklist
draftif it is not ready to be reviewed yet.feat: adding new MAPDL command)